home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDITOR / US20DOC.ARJ / SPELL.TXT < prev   
Text File  |  1992-07-04  |  9KB  |  222 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                    Using MicroSPELL                   Using MicroSPELL
  9.  
  10.                    version 2.0 - released July 4, 1992
  11.  
  12.                    Spelling Checker and Corrector                   ________ _______ ___ _________
  13.                    written by Daniel Lawrence                   _______ __ ______ ________
  14.  
  15.                    (C)Copyright 1987, 1992 by Daniel M. Lawrence
  16.  
  17.                    MicroSPELL 2.0 can be copied and distributed freely for any
  18.                    non-commercial purposes. Commercial users may use MicroSPELL
  19.                    2.0 inhouse. Shareware distributors may redistribute
  20.                    MicroSPELL 2.0 for media costs only. MicroSPELL 2.0 can only
  21.                    be incorporated into commercial software or resold with the
  22.                    permission of the author.
  23.  
  24.  
  25.  
  26.    Introduction   Introduction
  27.  
  28.            MicroSPELL 2.0 is a compact, efficient, fast spelling  checker  for use
  29.    both  as  a stand alone program, and with MicroEMACS v3.11 and  above  on  many
  30.    different computers.  Currently supported computers include IBM-PCs under MSDOS
  31.    and OS/2, ATARI ST, Amigas, and  UNIX  machines of various types. MicroSPELL is
  32.    supplied  both  as  IBM-PC executables, and  as  C  source  code  suitable  for
  33.    compilation by most C compilers.
  34.  
  35.            MicroSPELL  contains  tools  for  marking  misspellings,  scanning  for
  36.    replacements,  single  word  suggestions,   and   user   and   main  dictionary
  37.    maintenance. MicroSPELL is normally used in conjunction with MicroEMACS 3.11 in
  38.    order to scan text files,  stepping through misspellings and making suggestions
  39.    and corrections.
  40.  
  41.    Spell Correction   Spell Correction
  42.  
  43.            The SPELL program is responsible for scanning files and marking suspect
  44.    words.  The  SCAN.CMD  macro is used by MicroEMACS to then step through suspect
  45.    words, making suggestions, and  allowing  corrections.  This combination can be
  46.    called  in  two ways. If you have a text file in MicroEMACS, call up  the  Word
  47.    processing page (<F8>-W) and use the SHIFT-<F4> key to activate a spell scan on
  48.    the current buffer. Outside of MicroEMACS, use the SPELL command as follows:
  49.  
  50.            spell {<options>} <file> {<file>.........<file>}
  51.  
  52.    The currently available options are:
  53.  
  54.    -d              debugging mode
  55.  
  56.  
  57.  
  58.    -e              use MicroEMACS to scan errors
  59.    -u <fname>      use a user word list
  60.    -w              output a word list instead of a location list
  61.  
  62.    Example   Example
  63.  
  64.            Let's assume that you want to  spell  check a text file called text.txt
  65.    which is on the B drive of your machine.  To invoke spell type:                   B
  66.  
  67.            spell -e b:text.txt           spell -e b:text.txt
  68.  
  69.            Be patient.    It  will  take SPELL a short while to complete its setup
  70.    procedure.  If would like to know more about what SPELL is doing at this point,
  71.    you can set the debugging switch (-d} when you first invoke the program.  SPELL                                     -d
  72.    will then give you detailed information about what it is doing.
  73.  
  74.            When  SPELL  has  finished  checking  your  file  against its  internal
  75.    dictionary, it will give you a brief report of how many suspect words it found,
  76.    and then, since we used the -e switch, it will invoke  MicroEMACS  in  order to                               -e
  77.    scan through  the  suspect  words.   You will see the screen divided into three
  78.    windows.  The  top  window is the SPELL functions and status window. The middle
  79.    window  will  display  suggested replacements during the spell scan. The bottom
  80.    most window will contain a portion of the document being  scanned,  so that you
  81.    can see the suspect words in context.
  82.  
  83.            There are a number of elements in the uppermost window that you need to
  84.    be aware of.  On the top line, the "File" field lists which  file  the  scan is
  85.    currently  on.    This is useful when many different files  are  spell  checked
  86.    together in one  run  (many file names can be put on the command line at once).
  87.    The first number is the current file, and the second number is the total number
  88.    of files.
  89.  
  90.            The  second  field  on the top line is the "Word" filed. This describes
  91.    the current suspect word and the total number of suspect  words  in the current
  92.    file.  This will give you an idea of how  far  throughout  the  file  you  have
  93.    progressed during the scan.
  94.  
  95.            One at a time, each suspect word in the file is  presented  to  you for
  96.    you to decide on its disposition.   The  suspect  word  is  displayed,  and the
  97.    question "Option:" appears in the Dialog Window.  The options you have include:
  98.  
  99.    (S)kip          Skip this word, leaving it alone, and go on to the next.
  100.  
  101.    (I)gnore        Ignore this word and all other occurences of this word
  102.                    during this scan.
  103.  
  104.    (C)hange        Change this word.  You will be asked to type a
  105.                    replacement word.  This word will replace the original
  106.                    and MicroSPELL will remember the replacement.
  107.  
  108.  
  109.  
  110.                                         - 2 -
  111.  
  112.  
  113.  
  114.    (D)efault       If you have already replaced an identical occurrence
  115.       replace      of this suspect word, MicroSPELL will present the last
  116.                    replacement as a "Default Replacement".  Picking this
  117.                    option automatically replaces the suspect word with
  118.                    this default word.
  119.  
  120.    (G)lobal        When you first encounter a suspect word, if you wish
  121.        change      it to be replaced in the entire document, use this
  122.                    option. You will be prompted for the replacement word.
  123.  
  124.    (A)dd word      To a user dictionary.  This word will then be remembered
  125.                    for the remainder of the current scan, and also for all
  126.                    future scans when that user dictionary is invoked.
  127.  
  128.    (U)pper case    Add a word to a user dictionary in its current case.
  129.                    This is good for names, proper nouns and acronyms.
  130.  
  131.    (Q)uit          Finish the current scan, saving the file with the
  132.                    already completed changes. MicroSPELL will ask if you
  133.                    want to save the results of the scan, or discard them.
  134.  
  135.            Also, in the center window may be a list of possible replacement words.
  136.    An  arrow to the right of one of these words indicated which word is  currently
  137.    selected. The cursor keys can be used to  move  the  arrow  through the list of
  138.    words.  The  <RETURN>  key  causes  the  suspect  word to be replaced with  the
  139.    currently selected replacement word.
  140.  
  141.    Using the Mouse   Using the Mouse
  142.  
  143.            During the spell check run, the mouse can be clicked  on  any option to
  144.    use that option. Clicking on one of the replacement words  causes  that word to
  145.    replace the suspect word.
  146.  
  147.    Merging a user word list into the Main Dictionary   Merging a user word list into the Main Dictionary
  148.  
  149.            While  normally  you  would probably keep your user word lists separate
  150.    from  the main dictionary, if you discover a common english word or words which
  151.    appear missing from the main dictionary, the DMERGE program is used.
  152.  
  153.            dmerge <output dictionary> <user file> {<user file>..}           dmerge <output dictionary> <user file> {<user file>..}
  154.  
  155.            One  or  more  user word lists will be merged with the currently active
  156.    dictionary resulting in a new word list containing both the main dictionary and
  157.    the given user word lists. Then you would go on to use . . .
  158.  
  159.    Creating New Dictionaries   Creating New Dictionaries
  160.  
  161.            CDICT is the program that takes an alphabetized file of words, one to a
  162.    line, and creates a compressed dictionary which MicroSPELL can use.
  163.  
  164.  
  165.  
  166.                                         - 3 -
  167.  
  168.  
  169.  
  170.            CDICT <text dictionary> <compressed dictionary>           CDICT <text dictionary> <compressed dictionary>
  171.  
  172.    Support:   Support:
  173.  
  174.            If you wish to register this program, and be entitled to phone support,
  175.    please  send $25 to the address given below. If you do not yet have  MicroSPELL
  176.    2.0, specify which  disk format you would like it sent on. Currently I can make
  177.    IBM-PC 5 1/4"  and  3  1/2".  Other  formats  can  be made available by special
  178.    arrangement.
  179.  
  180.            If you make what you think are changes that are useful to many, send me
  181.    the updates, and as time permits, I will incorporate the ones I understand, and
  182.    agree with into the master sources.
  183.  
  184.            USmail: Daniel Lawrence
  185.                    617 New York St
  186.                    Lafayette, IN 47901
  187.  
  188.            UUCP:   dynamo.ecn.purdue.edu!mdbs!dan
  189.            ARPA:   mdbs!dan@dynamo.ecn.purdue.edu
  190.            FIDO:   The Programmer's Room 1:201/10
  191.                    (317) 742-5533
  192.            ATT:    (317) 742-5153
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.                                         - 4 -